SimilarWeb Domain Analytics API provides you with website traffic and competitor data. You will receive total website visits, website traffic by countries along with its sources, site ranks, and various competitor data. This data is especially useful for running competitor analysis and market intelligence campaigns. Note that you can get data only for websites with over 5,000 monthly visitors due to SimilarWeb restrictions.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
try {
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
} catch (RestClientException $e) {
echo "n";
print "HTTP code: {$e->getHttpCode()}n";
print "Error code: {$e->getCode()}n";
print "Message: {$e->getMessage()}n";
print $e->getTraceAsString();
echo "n";
exit();
}
$post_array = array();
// You can set only one task at a time
$post_array[] = array(
"target" => "inc.com"
);
try {
// POST /v3/domain_analytics/similarweb/live
$result = $client->post('/v3/domain_analytics/similarweb/live', $post_array);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
echo "n";
print "HTTP code: {$e->getHttpCode()}n";
print "Error code: {$e->getCode()}n";
print "Message: {$e->getMessage()}n";
print $e->getTraceAsString();
echo "n";
}
$client = null;
?>
The above command returns JSON structured like this:
{
"version": "0.1.20220216",
"status_code": 20000,
"status_message": "Ok.",
"time": "14.1072 sec.",
"cost": 0.02,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "03201924-1535-0003-0000-24ae07536329",
"status_code": 20000,
"status_message": "Ok.",
"time": "14.0403 sec.",
"cost": 0.02,
"result_count": 1,
"path": [
"v3",
"domain_analytics",
"similarweb",
"live"
],
"data": {
"api": "domain_analytics",
"function": "live",
"se": "similarweb",
"target": "indeed.com"
},
"result": [
{
"site_url": "indeed.com",
"company_name": "Indeed, Inc.",
"site_description": "with indeed, you can search millions of jobs online to find the next step in your career. with tools for job search, resumes, company reviews and more, we're with you every step of the way.",
"global_rank": {
"rank": 37
},
"country_rank": {
"rank": 27,
"country": "United States"
},
"category_rank": {
"rank": 1,
"category": "jobs_and_career/jobs_and_employment"
},
"headquarters": {
"country": "United States",
"state": "Texas",
"city": "Austin"
},
"revenue": {
"revenue_min": 1000000000,
"revenue_max": null
},
"employees": {
"employees_min": 10001,
"employees_max": null
},
"audience": {
"visits": 606867923,
"time_on_site_avg": "00:06:16",
"page_views_avg": 7.738058610189683,
"bounce_rate": 34.71,
"top_categories": [
{
"title": "Jobs and Employment",
"category_id": "jobs_and_career/jobs_and_employment"
},
{
"title": "Programming and Developer Software",
"category_id": "computers_electronics_and_technology/programming_and_developer_software"
},
{
"title": "Other Computers Electronics and Technology",
"category_id": "computers_electronics_and_technology/computers_electronics_and_technology"
},
{
"title": "News and Media",
"category_id": "news_and_media"
}
],
"other_visited_websites": [
"linkedin.com",
"mail.google.com",
"facebook.com",
"quora.com",
"glassdoor.com"
],
"top_topics": [
"news",
"jobs",
"google",
"business",
"search"
]
},
"traffic": {
"value": 606867923,
"percent": 100,
"countries": [
{
"country": "United States",
"value": 273207299,
"percent": 45.02
},
{
"country": "United Kingdom",
"value": 52516544,
"percent": 8.65
},
{
"country": "Canada",
"value": 50655674,
"percent": 8.35
},
{
"country": "France",
"value": 24012856,
"percent": 3.96
},
{
"country": "India",
"value": 21406213,
"percent": 3.53
},
{
"country": "other",
"value": 185034029,
"percent": 30.49
}
],
"sources": {
"direct": {
"value": 273871596,
"percent": 45.13
},
"search_organic": {
"value": 263399126,
"percent": 43.4,
"top_keywords": [
{
"keyword": "indeed",
"value": 114507417,
"percent": 43.47
},
{
"keyword": "indeed jobs",
"value": 11341451,
"percent": 4.31
},
{
"keyword": "indeed.com",
"value": 2141490,
"percent": 0.81
},
{
"keyword": "indeed login",
"value": 1850483,
"percent": 0.7
},
{
"keyword": "indeed canada",
"value": 1703608,
"percent": 0.65
}
]
},
"search_ad": {
"value": 17080340,
"percent": 2.81,
"top_keywords": null
},
"referring": {
"value": 6353652,
"percent": 1.05,
"top_referring": [
{
"site": "",
"value": 802692,
"percent": 12.63,
"percentage_change": 0
},
{
"site": "",
"value": 672452,
"percent": 10.58,
"percentage_change": 0
},
{
"site": "jobs.smartrecruiters.com",
"value": 494334,
"percent": 7.78,
"percentage_change": 0
},
{
"site": "click.appcast.io",
"value": 298293,
"percent": 4.69,
"percentage_change": 0
},
{
"site": "recruiting.adp.com",
"value": 178536,
"percent": 2.81,
"percentage_change": 0
}
]
},
"referral_destination": {
"top_destinations": [
{
"site": "",
"value": 935121,
"percent": 14.72,
"percentage_change": 0
},
{
"site": "",
"value": 686847,
"percent": 10.81,
"percentage_change": 0
},
{
"site": "recruiting.ultipro.com",
"value": 107473,
"percent": 1.69,
"percentage_change": 0
},
{
"site": "jobs.lever.co",
"value": 93266,
"percent": 1.47,
"percentage_change": 0
},
{
"site": "governmentjobs.com",
"value": 89324,
"percent": 1.41,
"percentage_change": 0
}
]
},
"social": {
"value": 10534024,
"percent": 1.74,
"top_socials": [
{
"site": "Youtube",
"value": 4954737,
"percent": 47.04
},
{
"site": "Facebook",
"value": 2059355,
"percent": 19.55
},
{
"site": "Linkedin",
"value": 1417751,
"percent": 13.46
},
{
"site": "Twitter",
"value": 521067,
"percent": 4.95
},
{
"site": "Reddit",
"value": 507561,
"percent": 4.82
}
]
},
"display_ad": {
"value": 675811,
"percent": 0.11,
"top_publishers": null,
"top_ad_networks": [
{
"site": "",
"value": 233851,
"percent": 34.6
},
{
"site": "",
"value": 59608,
"percent": 8.82
},
{
"site": "bild.de",
"value": 57386,
"percent": 8.49
},
{
"site": "search-assistbar.estart.jp",
"value": 56513,
"percent": 8.36
},
{
"site": "cbssports.com",
"value": 38000,
"percent": 5.62
}
]
},
"mobile_apps": {
"google_play_store": null,
"app_store": null
},
"mail": {
"value": 34953369,
"percent": 5.76
}
},
"estimated": [
{
"date": "2021-12-01",
"value": 514901306
},
{
"date": "2022-01-01",
"value": 644241712
},
{
"date": "2022-02-01",
"value": 606867923
}
]
},
"sites": {
"similar_sites": [
{
"site": "glassdoor.com",
"rank": 5
},
{
"site": "monster.com",
"rank": 94
},
{
"site": "simplyhired.com",
"rank": 104
},
{
"site": "ziprecruiter.com",
"rank": 8
},
{
"site": "careerbuilder.com",
"rank": 96
},
{
"site": "thebalancecareers.com",
"rank": 101
},
{
"site": "snagajob.com",
"rank": 203
},
{
"site": "usajobs.gov",
"rank": 34
},
{
"site": "themuse.com",
"rank": 167
},
{
"site": "dice.com",
"rank": 200
}
],
"similar_sites_by_rank": null
},
"date": "2022-02-01"
}
]
}
]
}
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. SimilarWeb Domain Analytics API can handle only 30 tasks per minute due to SimilarWeb restrictions. You might receive limit-related errors if over 30 SimilarWeb Domain Analytics API calls were sent to our system within a minute.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
| Field name | Type | Description |
|---|---|---|
target |
string | website domain required field you need to specify the domain you want to receive results for example: “website.com” |
tag |
string | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data array of the response |
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
| Field name | Type | Description |
|---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the same parameters that you specified in the POST request |
result |
array | array of results |
site_url |
string | target url targeted domain URL |
company_name |
string | name of the company name of the company the target domain belongs to |
site_description |
string | description metatag of the main page |
global_rank |
object | traffic rank of a targeted domain as compared to other domains in the world |
rank |
integer | global rank value |
country_rank |
object | traffic rank of a targeted domain as compared to other domains in the leading country |
rank |
integer | country rank value |
country |
string | the leading country |
category_rank |
object | traffic rank of a targeted domain as compared to other domains in the main category |
rank |
integer | category rank value |
category |
string | the main category |
headquarters |
object | headquarters of the company |
country |
string | headquarters country |
state |
string | headquarters state |
city |
string | headquarters city |
revenue |
object | revenue of the company |
revenue_min |
integer | minimum revenue of the company |
revenue_max |
integer | maximum revenue of the company |
employees |
object | number of employees working for the company |
employees_min |
integer | minimum number of employees |
employees_max |
integer | maximum number of employees |
audience |
object | overall traffic and engagement metrics on desktop and mobile devices |
visits |
integer | total monthly visits |
time_on_site_avg |
float | time on site average session duration |
page_views_avg |
float | page views average number of pages viewed during the session |
bounce_rate |
float | bounce rate the percentage of visitors who navigated away from the site after viewing only one page |
top_categories |
array | top categories categories most visited by the users of the analyzed site you can get the full list of possible categories with their titles and ids by this link |
title |
string | category title |
category_id |
string | category id |
other_visited_websites |
array | other visited websites visitors of the analyzed site also visited these websites |
top_topics |
array | top topics top tags on the websites visted by the users of the analyzed site |
traffic |
object | traffic and its sources for desktop only |
value |
integer | total traffic volume |
percent |
float | total traffic volume percentage |
countries |
array | traffic by countries |
country |
string | country |
value |
integer | traffic volume from a country |
percent |
float | percentage of total traffic |
sources |
object | traffic sources for desktop only |
direct |
object | direct traffic |
value |
integer | direct traffic volume |
percent |
float | percentage of direct traffic |
search_organic |
object | organic search traffic |
value |
integer | organic search traffic volume |
percent |
float | percentage of organic search traffic |
top_keywords |
array | top organic search keywords by traffic volume |
keyword |
string | organic search keyword |
value |
integer | organic searcht raffic volume brought by a keyword |
percent |
float | percentage of organic search traffic brought by a keyword |
search_ad |
object | paid search traffic |
value |
integer | paid search traffic volume |
percent |
float | percentage of paid search traffic |
top_keywords |
array | top paid search keywords by traffic volume |
keyword |
string | paid search keyword |
value |
integer | paid search traffic volume brought by a keyword |
percent |
float | percentage of paid search traffic brought by a keyword |
referring |
object | organic referral traffic |
value |
integer | organic referral traffic volume |
percent |
float | percentage of organic referral traffic |
top_referring |
array | top referring sites |
site |
string | referral site |
value |
integer | organic referral traffic volume from a site |
percent |
float | percentage of organic referral traffic volume from a site |
referral_destination |
object | sites that a targeted domain refers to |
top_destinations |
array | top sites that a targeted domain refers to |
site |
string | destination site |
social |
object | social traffic |
value |
integer | social traffic volume |
percent |
float | percentage of social traffic |
top_socials |
array | top social networks by traffic volume |
site |
string | social network |
value |
integer | traffic volume |
percent |
float | percentage of traffic volume |
display_ad |
object | traffic gained through display advertising |
value |
integer | traffic volume from display ads |
percent |
float | percentage of traffic |
top_publishers |
array | leading paid referring sites by traffic volume |
site |
string | publisher referring advertising traffic to the site |
top_ad_networks |
array | top ad networks by traffic volume |
site |
string | ad network |
value |
integer | traffic volume |
percent |
float | percentage of traffic volume |
mobile_apps |
object | mobile apps related to the targeted domain |
google_play_store |
array | related mobile apps in Google Play Store |
app_id |
string | unique application ID |
app_title |
string | application title |
app_price |
string | application price |
app_rating |
string | application rating |
app_link |
string | application link in Google Play Store |
app_store |
array | related mobile apps in Apple Store |
app_id |
string | unique application ID |
app_title |
string | application title |
app_price |
string | application price |
app_rating |
string | application rating |
app_link |
string | application link in Apple Store |
mail |
object | traffic from email campaigns |
value |
integer | mail traffic value |
percent |
float | mail traffic percentage |
estimated |
array | estimated traffic in previous months |
date |
string | date for which the traffic is estimated “yyyy-mm-dd” format is used |
value |
integer | monthly traffic value |
sites |
object | competitors and similar sites |
similar_sites |
array | sites similar to the targeted site sites that share the same audience, or compete for the same keywords, or have сommon links to and from the compared sites, or share similar content |
site |
string | similar site |
rank |
integer | global rank of a site |
similar_sites_by_rank |
array | sites similar to the targeted site sites that have close global rank values |
site |
string | similar site |